1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
use crate::app::event::Event;
use crate::app::state::{Consumed, SessionHelper};
use crate::app::{AeonError, DynError};
use crate::sketchbook::data_structs::{
    ChangeArgEssentialData, ChangeArgMonotoneData, ModelData, UninterpretedFnData,
};
use crate::sketchbook::event_utils::{make_reversible, mk_model_event, mk_model_state_change};
use crate::sketchbook::ids::UninterpretedFnId;
use crate::sketchbook::model::{ModelState, UninterpretedFn};
use crate::sketchbook::JsonSerde;

/* Constants for event path segments in `ModelState` related to uninterpreted functions. */

// add new prepared function
const ADD_FN_PATH: &str = "add";
// add new default function
const ADD_DEFAULT_FN_PATH: &str = "add_default";
// remove particular function
const REMOVE_FN_PATH: &str = "remove";
// set function's raw data
const SET_DATA_PATH: &str = "set_data";
// set function's ID
const SET_ID_PATH: &str = "set_id";
// set function's arity
const SET_ARITY_PATH: &str = "set_arity";
// increment function's arity
const INCREMENT_ARITY_PATH: &str = "increment_arity";
// decrement function's arity
const DECREMENT_ARITY_PATH: &str = "decrement_arity";
// set function's expression
const SET_EXPRESSION_PATH: &str = "set_expression";
// set monotonicity of function with respect to its argument
const SET_MONOTONICITY_PATH: &str = "set_monotonicity";
// set essentiality of function with respect to its argument
const SET_ESSENTIALITY_PATH: &str = "set_essentiality";

/// Implementation for events related to `uninterpreted functions` of the model.
impl ModelState {
    /// Perform events related to `uninterpreted fns` component of this `ModelState`.
    pub(super) fn perform_uninterpreted_fn_event(
        &mut self,
        event: &Event,
        at_path: &[&str],
    ) -> Result<Consumed, DynError> {
        let component_name = "model/uninterpreted_fn";

        // there is either adding of a new uninterpreted_fn, or editing/removing of an existing one
        // when adding new uninterpreted fn, the `at_path` is just ["add"] or ["add_default"]
        // when editing existing uninterpreted fn, the `at_path` is ["fn_id", "<action>"]

        if Self::starts_with(ADD_DEFAULT_FN_PATH, at_path).is_some() {
            Self::assert_path_length(at_path, 1, component_name)?;
            self.event_add_default_uninterpreted_fn(event)
        } else if Self::starts_with(ADD_FN_PATH, at_path).is_some() {
            Self::assert_path_length(at_path, 1, component_name)?;
            self.event_add_uninterpreted_fn(event)
        } else {
            Self::assert_path_length(at_path, 2, component_name)?;
            let fn_id_str = at_path.first().unwrap();
            let fn_id = self.get_uninterpreted_fn_id(fn_id_str)?;

            self.event_modify_uninterpreted_fn(event, &at_path[1..], fn_id)
        }
    }

    /// Perform event of adding a new `uninterpreted fn` component to this `ModelState`.
    /// This variant assumes that ID, arity (and so on) were already given.
    ///
    /// For now, it is assumed that new functions have no constraints (monotonicity, essentiality,
    /// or expression).
    pub(super) fn event_add_uninterpreted_fn(
        &mut self,
        event: &Event,
    ) -> Result<Consumed, DynError> {
        let component_name = "model/uninterpreted_fn";

        // parse the payload
        let payload = Self::clone_payload_str(event, component_name)?;
        let fn_data = UninterpretedFnData::from_json_str(payload.as_str())?;
        let arity = fn_data.arguments.len();
        // add funtion in two steps (to also include annotation)
        self.add_empty_uninterpreted_fn_by_str(&fn_data.id, &fn_data.name, arity)?;
        self.set_fn_annot_by_str(&fn_data.id, &fn_data.annotation)?;

        // prepare the state-change and reverse event (which is a remove event)
        let reverse_at_path = ["uninterpreted_fn", &fn_data.id, "remove"];
        let reverse_event = mk_model_event(&reverse_at_path, None);
        Ok(make_reversible(event.clone(), event, reverse_event))
    }

    /// Perform event of adding a new "default" `uninterpreted fn` component to this `ModelState`.
    ///
    /// The field values will be newly generated or predefined ("default") constants will be used.
    /// Particularly, new ID will be generated, the same string will be used for its name, and
    /// arity will be zero.
    /// Default function symbols also have no constraints (monotonicity, essentiality, or expression).
    pub(super) fn event_add_default_uninterpreted_fn(
        &mut self,
        event: &Event,
    ) -> Result<Consumed, DynError> {
        let component_name = "model/uninterpreted_fn";
        Self::assert_payload_empty(event, component_name)?;

        let arity = 0;
        // start indexing at 1
        let fn_id = self.generate_uninterpreted_fn_id("fn", Some(1));
        let uninterpreted_fn = UninterpretedFn::new_without_constraints(fn_id.as_str(), arity)?;
        let fn_data = UninterpretedFnData::from_fn(&fn_id, &uninterpreted_fn);
        self.add_empty_uninterpreted_fn_by_str(&fn_data.id, &fn_data.name, arity)?;

        // prepare the state-change and reverse event (which is a remove event)
        let state_change = mk_model_state_change(&["uninterpreted_fn", "add"], &fn_data);
        let reverse_at_path = ["uninterpreted_fn", &fn_data.id, "remove"];
        let reverse_event = mk_model_event(&reverse_at_path, None);
        Ok(make_reversible(state_change, event, reverse_event))
    }

    /// Perform event of modifying or removing existing `uninterpreted fn` component of this `ModelState`.
    pub(super) fn event_modify_uninterpreted_fn(
        &mut self,
        event: &Event,
        at_path: &[&str],
        fn_id: UninterpretedFnId,
    ) -> Result<Consumed, DynError> {
        let component_name = "model/uninterpreted_fn";

        if Self::starts_with(REMOVE_FN_PATH, at_path).is_some() {
            // check that payload is really empty
            if event.payload.is_some() {
                let message = "Payload must be empty for uninterpreted fn removing.".to_string();
                return AeonError::throw(message);
            }

            // perform the event, prepare the state-change variant (move id from path to payload)
            // note that to remove an uninterpreted_fn, it must not be used in any update fn (checked during the call)
            let fn_data = UninterpretedFnData::from_fn(&fn_id, self.get_uninterpreted_fn(&fn_id)?);
            self.remove_uninterpreted_fn(&fn_id)?;
            let state_change = mk_model_state_change(&["uninterpreted_fn", "remove"], &fn_data);

            // prepare the reverse event
            let reverse_at_path = ["uninterpreted_fn", "add"];
            let payload = fn_data.to_json_str();
            let reverse_event = mk_model_event(&reverse_at_path, Some(&payload));
            Ok(make_reversible(state_change, event, reverse_event))
        } else if Self::starts_with(SET_DATA_PATH, at_path).is_some() {
            // get the payload - string with modified function data
            let payload = Self::clone_payload_str(event, component_name)?;
            let new_data = UninterpretedFnData::from_json_str(&payload)?;
            let new_fn = new_data.to_uninterpreted_fn(self)?;
            let original_fn = self.get_uninterpreted_fn(&fn_id)?;
            let original_data = UninterpretedFnData::from_fn(&fn_id, original_fn);
            if &new_fn == original_fn {
                return Ok(Consumed::NoChange);
            }

            // perform the event, prepare the state-change variant (move id from path to payload)
            self.set_raw_function(&fn_id, new_fn)?;
            let new_fn = self.get_uninterpreted_fn(&fn_id)?;
            let new_data = UninterpretedFnData::from_fn(&fn_id, new_fn);
            let state_change = mk_model_state_change(&["uninterpreted_fn", "set_data"], &new_data);

            // prepare the reverse event
            let mut reverse_event = event.clone();
            reverse_event.payload = Some(original_data.to_json_str());
            Ok(make_reversible(state_change, event, reverse_event))
        } else if Self::starts_with(SET_ID_PATH, at_path).is_some() {
            // get the payload - string for "new_id"
            let new_id = Self::clone_payload_str(event, component_name)?;
            if fn_id.as_str() == new_id.as_str() {
                return Ok(Consumed::NoChange);
            }

            // perform the ID change (which can modify many parts of the model)
            self.set_uninterpreted_fn_id_by_str(fn_id.as_str(), new_id.as_str())?;

            // This event is a bit special - since variable ID change can affect many parts of the model
            // (update fns, regulations, layout, ...), the event returns the whole updated model data to the FE.
            let model_data = ModelData::from_model(self);
            let state_change = mk_model_state_change(&["uninterpreted_fn", "set_id"], &model_data);

            // prepare the reverse event
            let reverse_at_path = ["uninterpreted_fn", new_id.as_str(), "set_id"];
            let reverse_event = mk_model_event(&reverse_at_path, Some(fn_id.as_str()));
            Ok(make_reversible(state_change, event, reverse_event))
        } else if Self::starts_with(SET_ARITY_PATH, at_path).is_some() {
            // get the payload - string for "new_arity"
            let new_arity: usize = Self::clone_payload_str(event, component_name)?.parse()?;
            let original_arity = self.get_uninterpreted_fn(&fn_id)?.get_arity();
            if new_arity == original_arity {
                return Ok(Consumed::NoChange);
            }

            // perform the event, prepare the state-change variant (move id from path to payload)
            self.set_uninterpreted_fn_arity(&fn_id, new_arity)?;
            let fn_data = UninterpretedFnData::from_fn(&fn_id, self.get_uninterpreted_fn(&fn_id)?);
            let state_change = mk_model_state_change(&["uninterpreted_fn", "set_arity"], &fn_data);

            // prepare the reverse event
            let mut reverse_event = event.clone();
            reverse_event.payload = Some(original_arity.to_string());
            Ok(make_reversible(state_change, event, reverse_event))
        } else if Self::starts_with(INCREMENT_ARITY_PATH, at_path).is_some() {
            Self::assert_payload_empty(event, component_name)?;

            // perform the event, prepare the state-change variant (move id from path to payload)
            self.increment_fn_arity(&fn_id)?;
            let fn_data = UninterpretedFnData::from_fn(&fn_id, self.get_uninterpreted_fn(&fn_id)?);
            let state_change =
                mk_model_state_change(&["uninterpreted_fn", "increment_arity"], &fn_data);

            // prepare the reverse event
            let reverse_at_path = ["uninterpreted_fn", fn_id.as_str(), "decrement_arity"];
            let reverse_event = mk_model_event(&reverse_at_path, None);
            Ok(make_reversible(state_change, event, reverse_event))
        } else if Self::starts_with(DECREMENT_ARITY_PATH, at_path).is_some() {
            Self::assert_payload_empty(event, component_name)?;

            // perform the event, prepare the state-change variant (move id from path to payload)
            self.decrement_fn_arity(&fn_id)?;
            let fn_data = UninterpretedFnData::from_fn(&fn_id, self.get_uninterpreted_fn(&fn_id)?);
            let state_change =
                mk_model_state_change(&["uninterpreted_fn", "decrement_arity"], &fn_data);

            // prepare the reverse event
            let reverse_at_path = ["uninterpreted_fn", fn_id.as_str(), "increment_arity"];
            let reverse_event = mk_model_event(&reverse_at_path, None);
            Ok(make_reversible(state_change, event, reverse_event))
        } else if Self::starts_with(SET_EXPRESSION_PATH, at_path).is_some() {
            // get the payload - string for "expression"
            let new_expression = Self::clone_payload_str(event, component_name)?;
            let original_expression = self
                .get_uninterpreted_fn(&fn_id)?
                .get_fn_expression()
                .to_string();
            // actually, this check is not that relevant, as the expressions might be "normalized" during parsing
            if new_expression == original_expression {
                return Ok(Consumed::NoChange);
            }

            // perform the event and check (again) that the new parsed version is different than the original
            self.set_uninterpreted_fn_expression(&fn_id, new_expression.as_str())?;
            let new_fn = self.get_uninterpreted_fn(&fn_id)?;
            let fn_data = UninterpretedFnData::from_fn(&fn_id, new_fn);
            if fn_data.expression == original_expression {
                return Ok(Consumed::NoChange);
            }

            // prepare the state-change and reverse event
            let state_change =
                mk_model_state_change(&["uninterpreted_fn", "set_expression"], &fn_data);
            let mut reverse_event = event.clone();
            reverse_event.payload = Some(original_expression);
            Ok(make_reversible(state_change, event, reverse_event))
        } else if Self::starts_with(SET_MONOTONICITY_PATH, at_path).is_some() {
            // get the payload and parse it
            let payload = Self::clone_payload_str(event, component_name)?;
            let change_data = ChangeArgMonotoneData::from_json_str(payload.as_str())?;
            let original_monotonicity = *self
                .get_uninterpreted_fn(&fn_id)?
                .get_monotonic(change_data.idx);
            if original_monotonicity == change_data.monotonicity {
                return Ok(Consumed::NoChange);
            }

            // perform the event, prepare the state-change variant (move id from path to payload)
            self.set_uninterpreted_fn_monotonicity(
                &fn_id,
                change_data.monotonicity,
                change_data.idx,
            )?;
            let fn_data = UninterpretedFnData::from_fn(&fn_id, self.get_uninterpreted_fn(&fn_id)?);
            let state_change =
                mk_model_state_change(&["uninterpreted_fn", "set_monotonicity"], &fn_data);

            // prepare the reverse event
            let mut reverse_event = event.clone();
            let reverse_change = ChangeArgMonotoneData::new(change_data.idx, original_monotonicity);
            reverse_event.payload = Some(reverse_change.to_json_str());
            Ok(make_reversible(state_change, event, reverse_event))
        } else if Self::starts_with(SET_ESSENTIALITY_PATH, at_path).is_some() {
            // get the payload and parse it
            let payload = Self::clone_payload_str(event, component_name)?;
            let change_data = ChangeArgEssentialData::from_json_str(payload.as_str())?;
            let original_essentiality = *self
                .get_uninterpreted_fn(&fn_id)?
                .get_essential(change_data.idx);
            if original_essentiality == change_data.essentiality {
                return Ok(Consumed::NoChange);
            }

            // perform the event, prepare the state-change variant (move id from path to payload)
            self.set_uninterpreted_fn_essentiality(
                &fn_id,
                change_data.essentiality,
                change_data.idx,
            )?;
            let fn_data = UninterpretedFnData::from_fn(&fn_id, self.get_uninterpreted_fn(&fn_id)?);
            let state_change =
                mk_model_state_change(&["uninterpreted_fn", "set_essentiality"], &fn_data);

            // prepare the reverse event
            let mut reverse_event = event.clone();
            let reverse_change =
                ChangeArgEssentialData::new(change_data.idx, original_essentiality);
            reverse_event.payload = Some(reverse_change.to_json_str());
            Ok(make_reversible(state_change, event, reverse_event))
        } else {
            Self::invalid_path_error_specific(at_path, component_name)
        }
    }
}